Object description ...


Properties


Animating

bool Animating

Gets whether the object is currently animating.


Baseline

int Baseline

Gets/sets the object's baseline. This can be 0 to use the object's Y position as its baseline.


BlockingHeight

Allows you to manually specify the blocking height of the base of the object.


BlockingWidth

Allows you to manually specify the blocking width of the base of the object.


Clickable

bool Clickable

Gets/sets whether the mouse can be clicked on this object or whether it passes straight through.


Frame

int Frame

Gets the current frame number during an animation.


Graphic

int Graphic

Gets/sets the sprite number that is currently displayed on the object.


ID

int ID

Gets the object's ID number.


IgnoreScaling

Gets/sets whether the object ignores walkable area scaling.


IgnoreWalkbehinds

bool IgnoreWalkbehinds

Gets/sets whether the object ignores walk-behind areas.


Loop

int Loop

Gets the current loop number during an animation.


Moving

bool Moving

Gets whether the object is currently moving.


Name

string Name

Gets the object's description.


Solid

Gets/sets whether other objects and characters can move through this object.


Transparency

int Transparency

Gets/sets the object's transparency.


View

int View

Gets the current view number during an animation.


Visible

bool Visible

Gets/sets whether the object is currently visible.


X

int X

Gets/sets the X co-ordinate of the object's bottom-left hand corner.


Y

int Y

Gets/sets the Y co-ordinate of the object's bottom-left hand corner.


Methods


Animate

void Animate(int loop, int delay, RepeatStyle repeatStyle, BlockingStyle blockingStyle, Direction direction)

Animates the object using its current view.


GetAtScreenXY

static Object GetAtScreenXY(int x, int y)

Returns the object at the specified location.


GetBinaryProperty

int GetBinaryProperty(string property)

Gets a binary integer Custom Property for this object.


GetBoolProperty

bool GetBoolProperty(string property)

Gets a bool Custom Property for this object.


GetIntegerProperty

LooseInteger GetIntegerProperty(string property)

Gets an integer Custom Property for this object.


GetTextProperty

string GetTextProperty(string property)

Gets a text Custom Property for this object.


IsCollidingWithObject

bool IsCollidingWithObject(Object obj)

Checks whether this object is colliding with another.


MergeIntoBackground

Merges the object's image into the room background, and disables the object.


Move

void Move(int x, int y, int speed, BlockingStyle blockingStyle, WalkWhere walkWhere)

Starts the object moving towards the specified co-ordinates.


RemoveTint

Removes a specific object tint, and returns the object to using the ambient room tint.


RunInteraction

void RunInteraction(CursorMode cursorMode)

Runs the event handler for the specified event.


SetBinaryProperty

void SetBinaryProperty(string property, int value)

Sets a binary integer Custom Property for this object.


SetBoolProperty

void SetBoolProperty(string property, bool value)

Sets a bool Custom Property for this object.


SetIntegerProperty

void SetIntegerProperty(string property, int value)

Sets an integer Custom Property for this object.


SetLightLevel

Set Object to individual light level.


SetPosition

void SetPosition(int x, int y)

Instantly moves the object to have its bottom-left at the new co-ordinates.


SetTextProperty

void SetTextProperty(string property, string value)

Sets a text Custom Property for this object.


SetView

void SetView(int view, int loop, int frame)

Sets the object to use the specified view, ahead of doing an animation.


StopAnimating

void StopAnimating()

Stops any currently running animation on the object.


StopMoving

void StopMoving()

Stops any currently running move on the object.


Tint

Tints the object to the specified colour.